FHIRFLARE Validation Toolkit – Quick Start Guide
Hosted at: https://flare.fhirlab.net
Audience: Medical personnel with basic understanding of FHIR and Implementation Guides (IGs)
1. Accessing the Toolkit
- Open your browser and go to: https://flare.fhirlab.net
- No installation required — Lite Mode runs entirely in the browser.
- All validation and conversion operations are performed client-side or via lightweight server calls.
2. Selecting and Importing IGs from the FHIR Registry
Steps
- Navigate to Search and Import IGs.
- Enter the IG name (e.g.,
hl7.fhir.au.base
) and select the desired version. - Click Import.
- The IG and its dependencies will be cached locally for validation use.
IGs are sourced from the official FHIR registry and Simplifier.net.
3. Uploading a Local IG
Steps
- Package your Implementation Guide as a
.tgz
file.- Note on naming convention: Package filenames must follow FHIR package naming standards (which are based on npm package naming):
- Format:
publisher.category.name-version.tgz
- Example:
example.fhir.ph.core.r4-0.1.0.tgz
- The name must match the
name
andversion
fields in the package’spackage.json
descriptor - See FHIR Package specification for more details
- Go to Manage IGs.
- Click Upload Local IG and select your
.tgz
file. - The toolkit will extract and register the IG for use in validation.
Useful for testing custom or unpublished IGs.
4. Validating FHIR Resources
Steps
- Go to the Validation section.
- Upload your FHIR resource file (JSON or XML).
- Select the IG to validate against (imported or uploaded).
- Click Validate.
- Review the validation report showing errors, warnings, and info messages.
- Recommended: Click the Process button to analyze and display additional requirements information implied by the package:
- Optional elements that could be included
- Must-support elements that implementers are required to understand
- This analysis helps ensure complete implementation of the IG requirements
Lite Mode uses local StructureDefinitions only. Terminology validation (e.g., ValueSet bindings) may be limited.